home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 2010 Software/Programs / PCGuia_programas.iso / Software / Utils / VLC Media Player / vlc-1.0.3-win32.exe / lua / playlist / README.txt < prev    next >
Encoding:
Text File  |  2009-10-30  |  1.2 KB  |  25 lines
  1. Instructions to code your own VLC Lua playlist script.
  2. $Id$
  3.  
  4. See lua/README.txt for generic documentation about Lua usage in VLC.
  5.  
  6. Examples: See dailymotion.lua, googlevideo.lua, metacafe.lua, youbtube.lua
  7.           and youtube_homepage.lua .
  8.  
  9. VLC Lua playlist modules should define two functions:
  10.  * probe(): returns true if we want to handle the playlist in this script
  11.  * parse(): read the incoming data and return playlist item(s)
  12.             Playlist items use the same format as that expected in the
  13.             playlist.add() function (see general lua/README.txt)
  14.  
  15. VLC defines a global vlc object with the following members:
  16.  * vlc.path: the URL string (without the leading http:// or file:// element)
  17.  * vlc.access: the access used ("http" for http://, "file" for file://, etc.)
  18.  * vlc.peek( <int> ): return the first <int> characters from the playlist file.
  19.  * vlc.read( <int> ): read <int> characters from the playlist file.
  20.                       THIS FUNCTION CANNOT BE USED IN probe().
  21.  * vlc.readline(): return a new line of playlist data on each call.
  22.                    THIS FUNCTION CANNOT BE USED IN probe().
  23.  
  24. Available VLC specific Lua modules: msg and strings. See lua/README.txt.
  25.